<!doctype html>
<html class="default no-js">
<head>
	<meta charset="utf-8">
	<meta http-equiv="X-UA-Compatible" content="IE=edge">
	<title>Job | zeebe-node</title>
	<meta name="description" content="Documentation for zeebe-node">
	<meta name="viewport" content="width=device-width, initial-scale=1">
	<link rel="stylesheet" href="../assets/css/main.css">
	<script async src="../assets/js/search.js" id="search-script"></script>
</head>
<body>
<header>
	<div class="tsd-page-toolbar">
		<div class="container">
			<div class="table-wrap">
				<div class="table-cell" id="tsd-search" data-index="../assets/js/search.json" data-base="..">
					<div class="field">
						<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
						<input id="tsd-search-field" type="text" />
					</div>
					<ul class="results">
						<li class="state loading">Preparing search index...</li>
						<li class="state failure">The search index is not available</li>
					</ul>
					<a href="../index.html" class="title">zeebe-node</a>
				</div>
				<div class="table-cell" id="tsd-widgets">
					<div id="tsd-filter">
						<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
						<div class="tsd-filter-group">
							<div class="tsd-select" id="tsd-filter-visibility">
								<span class="tsd-select-label">All</span>
								<ul class="tsd-select-list">
									<li data-value="public">Public</li>
									<li data-value="protected">Public/Protected</li>
									<li data-value="private" class="selected">All</li>
								</ul>
							</div>
							<input type="checkbox" id="tsd-filter-inherited" checked />
							<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
							<input type="checkbox" id="tsd-filter-externals" checked />
							<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
						</div>
					</div>
					<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
				</div>
			</div>
		</div>
	</div>
	<div class="tsd-page-title">
		<div class="container">
			<ul class="tsd-breadcrumb">
				<li>
					<a href="../modules.html">zeebe-node</a>
				</li>
				<li>
					<a href="Job.html">Job</a>
				</li>
			</ul>
			<h1>Interface Job&lt;Variables, CustomHeaderShape&gt;</h1>
		</div>
	</div>
</header>
<div class="container container-main">
	<div class="row">
		<div class="col-8 col-content">
			<section class="tsd-panel tsd-type-parameters">
				<h3>Type parameters</h3>
				<ul class="tsd-type-parameters">
					<li>
						<h4>Variables = <a href="IInputVariables.html" class="tsd-signature-type" data-tsd-kind="Interface">IInputVariables</a></h4>
					</li>
					<li>
						<h4>CustomHeaderShape = <a href="ICustomHeaders.html" class="tsd-signature-type" data-tsd-kind="Interface">ICustomHeaders</a></h4>
					</li>
				</ul>
			</section>
			<section class="tsd-panel tsd-hierarchy">
				<h3>Hierarchy</h3>
				<ul class="tsd-hierarchy">
					<li>
						<span class="target">Job</span>
						<ul class="tsd-hierarchy">
							<li>
								<a href="ZeebeJob.html" class="tsd-signature-type" data-tsd-kind="Interface">ZeebeJob</a>
							</li>
						</ul>
					</li>
				</ul>
			</section>
			<section class="tsd-panel-group tsd-index-group">
				<h2>Index</h2>
				<section class="tsd-panel tsd-index-panel">
					<div class="tsd-index-content">
						<section class="tsd-index-section ">
							<h3>Properties</h3>
							<ul class="tsd-index-list">
								<li class="tsd-kind-property tsd-parent-kind-interface"><a href="Job.html#bpmnProcessId" class="tsd-kind-icon">bpmn<wbr>Process<wbr>Id</a></li>
								<li class="tsd-kind-property tsd-parent-kind-interface"><a href="Job.html#customHeaders" class="tsd-kind-icon">custom<wbr>Headers</a></li>
								<li class="tsd-kind-property tsd-parent-kind-interface"><a href="Job.html#deadline" class="tsd-kind-icon">deadline</a></li>
								<li class="tsd-kind-property tsd-parent-kind-interface"><a href="Job.html#elementId" class="tsd-kind-icon">element<wbr>Id</a></li>
								<li class="tsd-kind-property tsd-parent-kind-interface"><a href="Job.html#elementInstanceKey" class="tsd-kind-icon">element<wbr>Instance<wbr>Key</a></li>
								<li class="tsd-kind-property tsd-parent-kind-interface"><a href="Job.html#key" class="tsd-kind-icon">key</a></li>
								<li class="tsd-kind-property tsd-parent-kind-interface"><a href="Job.html#processDefinitionVersion" class="tsd-kind-icon">process<wbr>Definition<wbr>Version</a></li>
								<li class="tsd-kind-property tsd-parent-kind-interface"><a href="Job.html#processInstanceKey" class="tsd-kind-icon">process<wbr>Instance<wbr>Key</a></li>
								<li class="tsd-kind-property tsd-parent-kind-interface"><a href="Job.html#processKey" class="tsd-kind-icon">process<wbr>Key</a></li>
								<li class="tsd-kind-property tsd-parent-kind-interface"><a href="Job.html#retries" class="tsd-kind-icon">retries</a></li>
								<li class="tsd-kind-property tsd-parent-kind-interface"><a href="Job.html#type" class="tsd-kind-icon">type</a></li>
								<li class="tsd-kind-property tsd-parent-kind-interface"><a href="Job.html#variables" class="tsd-kind-icon">variables</a></li>
								<li class="tsd-kind-property tsd-parent-kind-interface"><a href="Job.html#worker" class="tsd-kind-icon">worker</a></li>
							</ul>
						</section>
					</div>
				</section>
			</section>
			<section class="tsd-panel-group tsd-member-group ">
				<h2>Properties</h2>
				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
					<a name="bpmnProcessId" class="tsd-anchor"></a>
					<h3><span class="tsd-flag ts-flagReadonly">Readonly</span> bpmn<wbr>Process<wbr>Id</h3>
					<div class="tsd-signature tsd-kind-icon">bpmn<wbr>Process<wbr>Id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
					<aside class="tsd-sources">
						<ul>
							<li>Defined in <a href="https://github.com/camunda-community-hub/zeebe-client-node-js/blob/98cac69/src/lib/interfaces-1.0.ts#L236">src/lib/interfaces-1.0.ts:236</a></li>
						</ul>
					</aside>
					<div class="tsd-comment tsd-typography">
						<div class="lead">
							<p>The bpmn process ID of the job process definition</p>
						</div>
					</div>
				</section>
				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
					<a name="customHeaders" class="tsd-anchor"></a>
					<h3><span class="tsd-flag ts-flagReadonly">Readonly</span> custom<wbr>Headers</h3>
					<div class="tsd-signature tsd-kind-icon">custom<wbr>Headers<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Readonly</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">CustomHeaderShape</span><span class="tsd-signature-symbol">&gt;</span></div>
					<aside class="tsd-sources">
						<ul>
							<li>Defined in <a href="https://github.com/camunda-community-hub/zeebe-client-node-js/blob/98cac69/src/lib/interfaces-1.0.ts#L251">src/lib/interfaces-1.0.ts:251</a></li>
						</ul>
					</aside>
					<div class="tsd-comment tsd-typography">
						<div class="lead">
							<p>A set of custom headers defined during modelling</p>
						</div>
					</div>
				</section>
				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
					<a name="deadline" class="tsd-anchor"></a>
					<h3><span class="tsd-flag ts-flagReadonly">Readonly</span> deadline</h3>
					<div class="tsd-signature tsd-kind-icon">deadline<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
					<aside class="tsd-sources">
						<ul>
							<li>Defined in <a href="https://github.com/camunda-community-hub/zeebe-client-node-js/blob/98cac69/src/lib/interfaces-1.0.ts#L257">src/lib/interfaces-1.0.ts:257</a></li>
						</ul>
					</aside>
				</section>
				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
					<a name="elementId" class="tsd-anchor"></a>
					<h3><span class="tsd-flag ts-flagReadonly">Readonly</span> element<wbr>Id</h3>
					<div class="tsd-signature tsd-kind-icon">element<wbr>Id<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
					<aside class="tsd-sources">
						<ul>
							<li>Defined in <a href="https://github.com/camunda-community-hub/zeebe-client-node-js/blob/98cac69/src/lib/interfaces-1.0.ts#L242">src/lib/interfaces-1.0.ts:242</a></li>
						</ul>
					</aside>
					<div class="tsd-comment tsd-typography">
						<div class="lead">
							<p>The associated task element ID</p>
						</div>
					</div>
				</section>
				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
					<a name="elementInstanceKey" class="tsd-anchor"></a>
					<h3><span class="tsd-flag ts-flagReadonly">Readonly</span> element<wbr>Instance<wbr>Key</h3>
					<div class="tsd-signature tsd-kind-icon">element<wbr>Instance<wbr>Key<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
					<aside class="tsd-sources">
						<ul>
							<li>Defined in <a href="https://github.com/camunda-community-hub/zeebe-client-node-js/blob/98cac69/src/lib/interfaces-1.0.ts#L247">src/lib/interfaces-1.0.ts:247</a></li>
						</ul>
					</aside>
					<div class="tsd-comment tsd-typography">
						<div class="lead">
							<p>The unique key identifying the associated task, unique within the scope of the
							process instance</p>
						</div>
					</div>
				</section>
				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
					<a name="key" class="tsd-anchor"></a>
					<h3><span class="tsd-flag ts-flagReadonly">Readonly</span> key</h3>
					<div class="tsd-signature tsd-kind-icon">key<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
					<aside class="tsd-sources">
						<ul>
							<li>Defined in <a href="https://github.com/camunda-community-hub/zeebe-client-node-js/blob/98cac69/src/lib/interfaces-1.0.ts#L227">src/lib/interfaces-1.0.ts:227</a></li>
						</ul>
					</aside>
					<div class="tsd-comment tsd-typography">
						<div class="lead">
							<p>The key, a unique identifier for the job</p>
						</div>
					</div>
				</section>
				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
					<a name="processDefinitionVersion" class="tsd-anchor"></a>
					<h3><span class="tsd-flag ts-flagReadonly">Readonly</span> process<wbr>Definition<wbr>Version</h3>
					<div class="tsd-signature tsd-kind-icon">process<wbr>Definition<wbr>Version<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
					<aside class="tsd-sources">
						<ul>
							<li>Defined in <a href="https://github.com/camunda-community-hub/zeebe-client-node-js/blob/98cac69/src/lib/interfaces-1.0.ts#L238">src/lib/interfaces-1.0.ts:238</a></li>
						</ul>
					</aside>
					<div class="tsd-comment tsd-typography">
						<div class="lead">
							<p>The version of the job process definition</p>
						</div>
					</div>
				</section>
				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
					<a name="processInstanceKey" class="tsd-anchor"></a>
					<h3><span class="tsd-flag ts-flagReadonly">Readonly</span> process<wbr>Instance<wbr>Key</h3>
					<div class="tsd-signature tsd-kind-icon">process<wbr>Instance<wbr>Key<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
					<aside class="tsd-sources">
						<ul>
							<li>Defined in <a href="https://github.com/camunda-community-hub/zeebe-client-node-js/blob/98cac69/src/lib/interfaces-1.0.ts#L234">src/lib/interfaces-1.0.ts:234</a></li>
						</ul>
					</aside>
					<div class="tsd-comment tsd-typography">
						<div class="lead">
							<p>The job&#39;s process instance key</p>
						</div>
					</div>
				</section>
				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
					<a name="processKey" class="tsd-anchor"></a>
					<h3><span class="tsd-flag ts-flagReadonly">Readonly</span> process<wbr>Key</h3>
					<div class="tsd-signature tsd-kind-icon">process<wbr>Key<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
					<aside class="tsd-sources">
						<ul>
							<li>Defined in <a href="https://github.com/camunda-community-hub/zeebe-client-node-js/blob/98cac69/src/lib/interfaces-1.0.ts#L240">src/lib/interfaces-1.0.ts:240</a></li>
						</ul>
					</aside>
					<div class="tsd-comment tsd-typography">
						<div class="lead">
							<p>The key of the job process definition</p>
						</div>
					</div>
				</section>
				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
					<a name="retries" class="tsd-anchor"></a>
					<h3><span class="tsd-flag ts-flagReadonly">Readonly</span> retries</h3>
					<div class="tsd-signature tsd-kind-icon">retries<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
					<aside class="tsd-sources">
						<ul>
							<li>Defined in <a href="https://github.com/camunda-community-hub/zeebe-client-node-js/blob/98cac69/src/lib/interfaces-1.0.ts#L255">src/lib/interfaces-1.0.ts:255</a></li>
						</ul>
					</aside>
				</section>
				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
					<a name="type" class="tsd-anchor"></a>
					<h3><span class="tsd-flag ts-flagReadonly">Readonly</span> type</h3>
					<div class="tsd-signature tsd-kind-icon">type<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
					<aside class="tsd-sources">
						<ul>
							<li>Defined in <a href="https://github.com/camunda-community-hub/zeebe-client-node-js/blob/98cac69/src/lib/interfaces-1.0.ts#L232">src/lib/interfaces-1.0.ts:232</a></li>
						</ul>
					</aside>
					<div class="tsd-comment tsd-typography">
						<div class="lead">
							<p>The job type, as defined in the BPMN process (e.g. &lt;zeebe:taskDefinition
							type=&quot;payment-service&quot; /&gt;)</p>
						</div>
					</div>
				</section>
				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
					<a name="variables" class="tsd-anchor"></a>
					<h3><span class="tsd-flag ts-flagReadonly">Readonly</span> variables</h3>
					<div class="tsd-signature tsd-kind-icon">variables<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">Readonly</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">Variables</span><span class="tsd-signature-symbol">&gt;</span></div>
					<aside class="tsd-sources">
						<ul>
							<li>Defined in <a href="https://github.com/camunda-community-hub/zeebe-client-node-js/blob/98cac69/src/lib/interfaces-1.0.ts#L261">src/lib/interfaces-1.0.ts:261</a></li>
						</ul>
					</aside>
					<div class="tsd-comment tsd-typography">
						<div class="lead">
							<p>All visible variables in the task scope, computed at activation time.</p>
						</div>
					</div>
				</section>
				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
					<a name="worker" class="tsd-anchor"></a>
					<h3><span class="tsd-flag ts-flagReadonly">Readonly</span> worker</h3>
					<div class="tsd-signature tsd-kind-icon">worker<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
					<aside class="tsd-sources">
						<ul>
							<li>Defined in <a href="https://github.com/camunda-community-hub/zeebe-client-node-js/blob/98cac69/src/lib/interfaces-1.0.ts#L253">src/lib/interfaces-1.0.ts:253</a></li>
						</ul>
					</aside>
					<div class="tsd-comment tsd-typography">
						<div class="lead">
							<p>The name of the worker that activated this job</p>
						</div>
					</div>
				</section>
			</section>
		</div>
		<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
			<nav class="tsd-navigation primary">
				<ul>
					<li class=" ">
						<a href="../modules.html">Exports</a>
					</li>
				</ul>
			</nav>
			<nav class="tsd-navigation secondary menu-sticky">
				<ul class="before-current">
				</ul>
				<ul class="current">
					<li class="current tsd-kind-interface tsd-has-type-parameter">
						<a href="Job.html" class="tsd-kind-icon">Job</a>
						<ul>
							<li class=" tsd-kind-property tsd-parent-kind-interface">
								<a href="Job.html#bpmnProcessId" class="tsd-kind-icon">bpmn<wbr>Process<wbr>Id</a>
							</li>
							<li class=" tsd-kind-property tsd-parent-kind-interface">
								<a href="Job.html#customHeaders" class="tsd-kind-icon">custom<wbr>Headers</a>
							</li>
							<li class=" tsd-kind-property tsd-parent-kind-interface">
								<a href="Job.html#deadline" class="tsd-kind-icon">deadline</a>
							</li>
							<li class=" tsd-kind-property tsd-parent-kind-interface">
								<a href="Job.html#elementId" class="tsd-kind-icon">element<wbr>Id</a>
							</li>
							<li class=" tsd-kind-property tsd-parent-kind-interface">
								<a href="Job.html#elementInstanceKey" class="tsd-kind-icon">element<wbr>Instance<wbr>Key</a>
							</li>
							<li class=" tsd-kind-property tsd-parent-kind-interface">
								<a href="Job.html#key" class="tsd-kind-icon">key</a>
							</li>
							<li class=" tsd-kind-property tsd-parent-kind-interface">
								<a href="Job.html#processDefinitionVersion" class="tsd-kind-icon">process<wbr>Definition<wbr>Version</a>
							</li>
							<li class=" tsd-kind-property tsd-parent-kind-interface">
								<a href="Job.html#processInstanceKey" class="tsd-kind-icon">process<wbr>Instance<wbr>Key</a>
							</li>
							<li class=" tsd-kind-property tsd-parent-kind-interface">
								<a href="Job.html#processKey" class="tsd-kind-icon">process<wbr>Key</a>
							</li>
							<li class=" tsd-kind-property tsd-parent-kind-interface">
								<a href="Job.html#retries" class="tsd-kind-icon">retries</a>
							</li>
							<li class=" tsd-kind-property tsd-parent-kind-interface">
								<a href="Job.html#type" class="tsd-kind-icon">type</a>
							</li>
							<li class=" tsd-kind-property tsd-parent-kind-interface">
								<a href="Job.html#variables" class="tsd-kind-icon">variables</a>
							</li>
							<li class=" tsd-kind-property tsd-parent-kind-interface">
								<a href="Job.html#worker" class="tsd-kind-icon">worker</a>
							</li>
						</ul>
					</li>
				</ul>
				<ul class="after-current">
				</ul>
			</nav>
		</div>
	</div>
</div>
<footer class="with-border-bottom">
	<div class="container">
		<h2>Legend</h2>
		<div class="tsd-legend-group">
			<ul class="tsd-legend">
				<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
				<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
				<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
			</ul>
			<ul class="tsd-legend">
				<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
				<li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
			</ul>
			<ul class="tsd-legend">
				<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
				<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
			</ul>
			<ul class="tsd-legend">
				<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li>
				<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li>
			</ul>
			<ul class="tsd-legend">
				<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
				<li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
			</ul>
			<ul class="tsd-legend">
				<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected method</span></li>
			</ul>
		</div>
	</div>
</footer>
<div class="container tsd-generator">
	<p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p>
</div>
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>
</body>
</html>